iT邦幫忙

2025 iThome 鐵人賽

0
自我挑戰組

飲食營養追蹤 + 健康分析 Web 系統系列 第 27

整理專案說明文件,寫README

  • 分享至 

  • xImage
  •  

目的

為我這個Java Console App專案寫一個README撰寫指南。

1.README是什麼?

  • 看我的專案時第一個會看到的文件。
  • 格式通常為.md , 表示使用Markdown語法撰寫。
  • 幫助使用者快速了解專案核心資訊。

2.開始撰寫
會以程式碼+呈現畫面的形式講。
先新增READMR.md檔案。
https://ithelp.ithome.com.tw/upload/images/20251026/20178845S3dyq5uOYU.jpg


介紹這個專案目的。
『#』為最大的標題 ,『#』越多代表標題越小 , 最小到6個。
https://ithelp.ithome.com.tw/upload/images/20251026/201788456T0GorAld1.jpghttps://ithelp.ithome.com.tw/upload/images/20251026/20178845bOKJMbvhrR.jpg


介紹專案架構。
『##』為次標題。
斜體文字前後各一個星號/『_ 』; 粗體文字前後各兩個星號/『__ 』; 粗體斜體文字前後各三個星號 ; 刪除線文字前後各兩個『~』
https://ithelp.ithome.com.tw/upload/images/20251026/20178845fdYOwHslPK.jpghttps://ithelp.ithome.com.tw/upload/images/20251026/20178845jmksxl2XFJ.jpg


講解環境設定與連線。
一個星號接一個空格 = 一個點。
標記程式碼、檔案名、特定命令可以用'將字包住。
『 | 』分隔欄位標題與內容。
| :--- | 左對齊 ;
| :---: |置中對齊 ;
| ---: |右對齊 ;
| --- |左對齊 (不加:的預設效果)。
https://ithelp.ithome.com.tw/upload/images/20251026/20178845TVeklJBR50.jpghttps://ithelp.ithome.com.tw/upload/images/20251026/20178845FioxkP8tlt.jpg


說明如何運行專案。
1.接一個空格 , ,Markdown會自動排序。
『 ''' 』程式碼區塊:用來包多行程式碼。
'''bash :接下來這個區塊內容是bash命令 , 請用bash語法來標注顏色。
表格的 - 的多寡只是讓我們在看時能看出大致結構 , 最終網頁的效果不會有影響。
https://ithelp.ithome.com.tw/upload/images/20251026/20178845fnOYBX2uAr.jpghttps://ithelp.ithome.com.tw/upload/images/20251026/20178845YvkIaY3uTA.jpg


3.最終呈現結果
https://ithelp.ithome.com.tw/upload/images/20251026/20178845UnEU6YQ7Qo.jpg
https://ithelp.ithome.com.tw/upload/images/20251026/20178845oBcdKjCR5Z.jpg
https://ithelp.ithome.com.tw/upload/images/20251026/20178845RmNTrLqypJ.jpg


上一篇
優化程式碼,確保DAO與主程式分離
下一篇
說明整體架構
系列文
飲食營養追蹤 + 健康分析 Web 系統30
圖片
  熱門推薦
圖片
{{ item.channelVendor }} | {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

尚未有邦友留言

立即登入留言